Optionen und Vorgehen bei der Modelldokumentation

Inhalt der Dokumentation

Der tatsächliche Inhalt der Dokumentation ergibt sich als Schnittmenge des gewählten Inhalts der Dokumentation (Selektion) und der konfigurierten Dokumentationsstruktur (Gliederung).

Modellelemente, die zwar als Inhalt bestimmt wurden, jedoch in der konfigurierten Dokumentationsstruktur nicht vorkommen, werden nicht Bestandteil der Dokumentation. Umgekehrt bleiben konfigurierte Dokumentationsstrukturen leer, wenn kein entsprechender Inhalt festgelegt wurde.

Als Inhalt der Dokumentation können Sie eine der folgenden Optionen wählen:

• Das aktive Dokument (Diagramm, Tabelle oder Spezifikation)
• Alle geöffneten Dokumente des Arbeitsbereichs
• Die aktuelle Selektion (optional rekursiv)
• Ein individueller Ausschnitt des Modells (Selektion im Dialog Assistent zur Dokumentationsgenerierung)
• Das gesamte Modell

Struktur der Dokumentation

Die Struktur der Dokumentation wird im Konfigurationseditor über die Dokumentationsstruktur festgelegt. Die Dokumentationsstruktur wird einer Auswahl zugeordnet, die auch Festlegungen zum Layout (z. B. Titelseite) enthält. Ein Dokumentationskommando greift auf eine Auswahl und damit auf eine Dokumentationsstruktur zurück. Eine Option des Dokumentationskommandos ist das Ausgabeformat (Ausgabeart). Alle Dokumentationskommandos mit den Ausgabeformaten Word-für-Windows-Dokument, XML-Dokument oder Voranzeigefenster werden im Dialog Assistent zur Dokumentationsgenerierung angeboten.

Ausgabeformate der Dokumentation

Sie können Dokumentationen in den folgenden Ausgabeformaten erzeugen:

• Als Word- Dokument

  Eine Modelldokumentation im Format 'Microsoft Office Word 2007' erzeugen. Verwenden Sie dieses Ausgabeformat, wenn Sie die Dokumentation ausdrucken oder als einzelne Datei versenden möchten.

  Sie generieren ein Dokument im Word-2007-Format (docx), dessen Layout Sie über ein Vorlagendokument spezifizieren können.

• Als XML/HTML

  Eine Modelldokumentation im Format 'XML' oder als Webseiten erzeugen. Verwenden Sie dieses Ausgabeformat, wenn Sie die Dokumentation auf einem Webserver veröffentlichen möchten

  Sie generieren ein XML-Dokument, das in einem Nachbearbeitungsschritt per XSL-T in HTML-Seiten umgewandelt wird.

  Das Verzeichnis für die Ausgabedateien bestimmen Sie im Dokumentationskommando. Vorgabe ist das lokale $(TEMP)-Verzeichnis des Benutzers.

  Hinweis:

  Beim Generieren der HTML-Seiten kann es zur Fehlermeldung "Zugriff verweigert" kommen. Das kann vermieden werden, wenn ".../Java/jre[5|6]/bin" in der Umgebungsvariablen %PATH% enthalten ist.

• Vorschau

  Sie erzeugen ein Vorschaufenster, das sich in das Innovator-Fenster einfügt. Sie können darin suchen, Verweise verfolgen sowie die Anzeige skalieren.

  Verwenden Sie die Dokumentvorschau, um einen schnellen Überblick über die zu generierende Dokumentation zu bekommen.

Grundsätzliches Vorgehen beim Erstellen einer Modelldokumentation

Durch die Optionen für den Inhalt und das Ausgabeformat beim Erstellen einer Modelldokumentation haben Sie vielfältige Möglichkeiten:

1. Wenn Sie nicht das ganze Modell dokumentieren, sondern den Inhalt der Dokumentation vorab bestimmen wollen, dann wählen Sie eine der Alternativen:

   1. Wenn Sie ein bestimmtes Dokument (Diagramm, Tabelle oder Spezifikation) dokumentieren wollen, dann aktivieren Sie es, so dass es im Vordergrund ist.
   2. Wenn Sie mehrere Dokumente dokumentieren wollen, dann öffnen Sie ausschließlich diese Dokumentenfenster.
   3. Wenn Sie bestimmte Modellelemente dokumentieren wollen, dann selektieren Sie diese. Sie können die Modellelemente alternativ im Assistent zur Dokumentationsgenerierung selektieren.

2. Wenn Sie das Ausgabeformat der Dokumentation vorab bestimmen wollen, dann wählen Sie eine der Alternativen:

   1. Wenn Sie ein Word-Dokument erstellen wollen, wählen Sie den Menübefehl Anwendungsmenü>Dokumentation Erstellen & Senden>Als Word- Dokument
   2. Wenn Sie die Dokumentation als XML-Datei und daraus generierten HTML-Seiten ausgeben wollen, wählen Sie den Menübefehl Anwendungsmenü>Dokumentation Erstellen & Senden>Als XML/HTML.
   3. Wenn Sie die Dokumentation im Vorschaufenster betrachten wollen, wählen Sie den Menübefehl Anwendungsmenü>Dokumentation Erstellen & Senden>Vorschau.
3. Wenn Sie das Ausgabeformat der Dokumentation nicht vorab bestimmen wollen, dann wählen Sie den Menübefehl Anwendungsmenü>Dokumentation Erstellen & Senden>Dokumentations-Assistent verwenden.
4. Wenn Sie einen individuellen Ausschnitt des Modells dokumentieren wollen, dann selektieren Sie diesen Inhalt der Dokumentation im Dialog Assistent zur Dokumentationsgenerierung.
5. Wenn Sie das zuletzt verwendete Dokumentationskommando benutzen und zur aktuellen Selektion eine Dokumentation erzeugen wollen, dann wählen Sie Anwendungsmenü>Dokumentation Erstellen & Senden> Erneut generieren.